Favicon

You are here: Home > API Reference > App Distribution > Application Collaborators > Add new collaborator

Add new collaborator

Required Permission: base.people.applicationCollaborator.create

Add new collaborator

POST
https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/collaborators 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/collaborators" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "email": [
    "[email protected]"
  ],
  "role": "owner",
  "tags": [
    "string"
  ],
  "sendInvitation": true
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/collaborators", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "email": [
      "[email protected]"
    ],
    "role": "owner",
    "tags": [
      "string"
    ],
    "sendInvitation": true
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/collaborators",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "email": [
        "[email protected]"
      ],
      "role": "owner",
      "tags": [
        "string"
      ],
      "sendInvitation": true
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
applicationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
email any required
role string required
owner admin editor viewer unassigned
tags array optional
sendInvitation any optional 
{
    "email": [
        "[email protected]"
    ],
    "role": "owner",
    "tags": [
        "string"
    ],
    "sendInvitation": true
}

Responses

200 Response application/json
status boolean required
data object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
organization string required
Match pattern: ^[a-fA-F0-9]{24}$
application any required
role string required
owner admin editor viewer unassigned
tags array required
user object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
email string required
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
firstName string required
≤ 128 characters
lastName string required
≤ 128 characters
picture string optional
role string required
user serviceAccount platformUser platformServiceAccount
ssoUser any required
detected object required
createdBy string required
Match pattern: ^[a-fA-F0-9]{24}$
updatedAt string required
createdAt string required 
{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "application": {
            "_id": "string",
            "description": "string",
            "name": "string",
            "slug": "string"
        },
        "role": "owner",
        "tags": [
            "string"
        ],
        "user": {
            "id": "string",
            "email": "[email protected]",
            "firstName": "string",
            "lastName": "string",
            "picture": "string",
            "role": "user",
            "ssoUser": true
        },
        "detected": {},
        "createdBy": "string",
        "updatedAt": "string",
        "createdAt": "string"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5017
message string optional
Limit Exceeded
{
    "status": false,
    "error": {
        "code": 5002,
        "message": "User is already a collaborator"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}